#ifndef INCLUDES_TARANTOOL_BOX_LUA_MISC_H
#define INCLUDES_TARANTOOL_BOX_LUA_MISC_H
/*
 * Copyright 2010-2016, Tarantool AUTHORS, please see AUTHORS file.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *
 * 1. Redistributions of source code must retain the above
 *    copyright notice, this list of conditions and the
 *    following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * <COPYRIGHT HOLDER> OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include <stddef.h>

#include "small/region.h"

#if defined(__cplusplus)
extern "C" {
#endif /* defined(__cplusplus) */

#include "lua/msgpack.h"

struct lua_State;
struct read_view;
struct key_def;
struct port;

char *
lbox_encode_tuple_on_gc(struct lua_State *L, int idx, size_t *p_len);

/**
 * Convert packed position, tuple or table from Lua to C packed position.
 * Returned position is allocated on the fiber region.
 */
int
lbox_normalize_position(lua_State *L, int idx, struct key_def *cmp_def,
			const char **packed_pos, const char **packed_pos_end);

/** Specialization of lbox_normalize_position for indexes. */
int
lbox_index_normalize_position(lua_State *L, int idx, int space_id,
			      int index_id, const char **packed_pos,
			      const char **packed_pos_end);

/**
 * Pushes a table that contains information about the given read view to
 * the Lua stack. Used in the Tarantool EE source code.
 */
void
lbox_push_read_view(struct lua_State *L, const struct read_view *rv);

void
box_lua_misc_init(struct lua_State *L);

/**
 * Helper function for dumping port contents to lua in the
 * `PORT_DUMP_LUA_MODE_MP_OBJECT` mode, which handles the case when the port is
 * not a MsgPack port and requires converting the contents of the port to
 * Msgpack.
 */
static inline void
port_dump_lua_mp_object_mode_slow(
	struct port *port, struct lua_State *L, struct region *region,
	const char *(*get_msgpack)(struct port *, uint32_t *))
{
	uint32_t region_svp = region_used(region);
	uint32_t size;
	const char *data = get_msgpack(port, &size);
	luamp_push(L, data, data + size);
	region_truncate(region, region_svp);
}

#if defined(__cplusplus)
} /* extern "C" */
#endif /* defined(__cplusplus) */

#endif /* INCLUDES_TARANTOOL_BOX_LUA_MISC_H */
